Package com.cisco.pt.ipc.sim.impl
Class FrameInstanceImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.FrameInstanceImpl
- All Implemented Interfaces:
IPCObject,FrameInstance
Information provided by the PKI file:
\class FrameInstance
\brief FrameInstance holds traffic details such as PDUs, ports, etc.
\example appWindow().getActiveFile().getMainSimulation().getFrameInstanceAt(0)
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionFrameInstanceImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDecision(String id, String description, boolean isOsiIn, int osiLayer) Information provided by the PKI file:getDecisionAt(int index) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:getFlowChartNodeAt(int nodeIndex) Information provided by the PKI file:intInformation provided by the PKI file:getFrameDecsionAt(int index) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getOutPort(int outPortIndex) Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:longInformation provided by the PKI file:intgetTime()Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidsetFrameAccepted(boolean accepted) Information provided by the PKI file:voidsetFrameBuffered(boolean buffered) Information provided by the PKI file:voidsetFrameDropped(boolean dropped) Information provided by the PKI file:voidsetFrameNotForwarded(boolean notForwarded) Information provided by the PKI file:voidsetFrameSent(boolean sent) Information provided by the PKI file:voidsetFrameUnexpected(boolean unexpected) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
FrameInstanceImpl
public FrameInstanceImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getUserTrafficType
Information provided by the PKI file:
\brief Returns the user traffic type. \return TrafficType, the user traffic type. User traffic types: eTrafficType_Icmp = 0, eTrafficType_Tcp = 1, eTrafficType_Udp = 2, eTrafficType_RipV1 = 3, eTrafficType_RipV2 = 4, eTrafficType_Arp = 5, eTrafficType_Cdp = 6, eTrafficType_Dhcp = 7, eTrafficType_Nat = 8, eTrafficType_Eigrp = 9, eTrafficType_Vtp = 10, eTrafficType_Stp = 11, eTrafficType_Ospf = 12, eTrafficType_Dtp = 13, eTrafficType_Telnet = 14, eTrafficType_Ssh = 15, eTrafficType_Tftp = 16, eTrafficType_Http = 17, eTrafficType_Https = 18, eTrafficType_Dns = 19, eTrafficType_Icmpv6 = 20, eTrafficType_Lacp = 21, eTrafficType_Pagp = 22, eTrafficType_Ipsec = 23, eTrafficType_Ike = 24, eTrafficType_Syslog = 25, eTrafficType_Tacacs = 26, eTrafficType_Radius = 27, eTrafficType_Snmp = 28, eTrafficType_Ntp = 29, eTrafficType_Ftp = 30, eTrafficType_Smtp = 31, eTrafficType_Pop3 = 32, eTrafficType_Sccp = 33, eTrafficType_Rtp = 34, eTrafficType_H323 = 35, eTrafficType_Bgp = 36, eTrafficType_Hsrp = 37, eTrafficType_Hsrpv6 = 38, eTrafficType_Netflow = 39, eTrafficType_Ndv6 = 40, eTrafficType_Ripng = 41, eTrafficType_Dhcpv6 = 42, eTrafficType_Eigrpv6 = 43, eTrafficType_Ospfv6 = 44, eTrafficType_IoE = 45, eTrafficType_Ptp = 46, eTrafficType_Rep = 47, eTrafficType_CapwapUdp = 48, eTrafficType_Lldp = 49, eTrafficType_Span = 50, eTrafficType_IoETcp = 51, eTrafficType_Usb = 52, eTrafficType_Bluetooth = 53, eTrafficType_Custom = 1000- Specified by:
getUserTrafficTypein interfaceFrameInstance- Returns:
- TrafficType Returns a TrafficType
-
getDestinationString
Information provided by the PKI file:
\brief Returns the destination. \return QString, the destination.- Specified by:
getDestinationStringin interfaceFrameInstance- Returns:
- String Returns a String
-
getSourceString
Information provided by the PKI file:
\brief Returns the source. \return QString, the source.- Specified by:
getSourceStringin interfaceFrameInstance- Returns:
- String Returns a String
-
getDevice
Information provided by the PKI file:
\brief Returns the current device the frame instance is at. \return Device, the Device object the frame instance is at.- Specified by:
getDevicein interfaceFrameInstance- Returns:
- Device Returns a Device
-
getPreviousDevice
Information provided by the PKI file:
\brief Returns the previous device the frame instance was at. \return Device, the Device object the frame instance was at.- Specified by:
getPreviousDevicein interfaceFrameInstance- Returns:
- Device Returns a Device
-
getInFrame
Information provided by the PKI file:
\brief Returns the inbound frame. \return Pdu, the inbound frame Pdu object.- Specified by:
getInFramein interfaceFrameInstance- Returns:
- Pdu Returns a Pdu
-
getOutFrame
Information provided by the PKI file:
\brief Returns the outbound frame. \return Pdu, the outbound frame Pdu object.- Specified by:
getOutFramein interfaceFrameInstance- Returns:
- Pdu Returns a Pdu
-
getInPort
Information provided by the PKI file:
\brief Returns the inbound port. \return Port, the inbound Port object.- Specified by:
getInPortin interfaceFrameInstance- Returns:
- Port Returns a Port
-
getOutPort
Information provided by the PKI file:
\brief returns the outbound port at the specified index. \param outPortIndex, the index of the outbound port of interest. \return Port, the outbound Port object at the specified index.- Specified by:
getOutPortin interfaceFrameInstance- Parameters:
outPortIndex- Takes in a parameter of outPortIndex- Returns:
- Port Returns a Port
-
getOutPortCount
public int getOutPortCount()Information provided by the PKI file:
\brief Returns the number of outbound ports. \return int, the number of outbound ports.- Specified by:
getOutPortCountin interfaceFrameInstance- Returns:
- int Returns a int
-
addDecision
Information provided by the PKI file:
\brief Adds a flowchart decision with the specified ID and description at the specified layer. \param id, the flowchart ID. \param description, the flowchart description. \param isOsiIn, true if inbound layer decision, false if outbound layer decision. \param osiLayer, the OSI layer.- Specified by:
addDecisionin interfaceFrameInstance- Parameters:
id- Takes in a parameter of iddescription- Takes in a parameter of descriptionisOsiIn- Takes in a parameter of isOsiInosiLayer- Takes in a parameter of osiLayer
-
getFlowChartNodeAt
Information provided by the PKI file:
\brief Returns the flowchart node at the specified index. \param nodeIndex, the index of the flowchart node of interest. \return FlowChartNode, the FlowChartNode object att he specified index.- Specified by:
getFlowChartNodeAtin interfaceFrameInstance- Parameters:
nodeIndex- Takes in a parameter of nodeIndex- Returns:
- FlowChartNode Returns a FlowChartNode
-
getFrameDecsionAt
Information provided by the PKI file:
\brief Returns the frame decision at the specified index. \param index, the index of the frame decision of interest. \return FrameDecision, the FrameDecision at the specified index.- Specified by:
getFrameDecsionAtin interfaceFrameInstance- Parameters:
index- Takes in a parameter of index- Returns:
- FrameDecision Returns a FrameDecision
-
getFlowChartNodeCount
public int getFlowChartNodeCount()Information provided by the PKI file:
\brief Returns the number of flowchart nodes. \return int, the number of flowchart nodes.- Specified by:
getFlowChartNodeCountin interfaceFrameInstance- Returns:
- int Returns a int
-
getDecisionAt
Information provided by the PKI file:
\brief Returns the decision at the specified index. \param index, the index of the decision of interest. \return QString, the decision at the specified index.- Specified by:
getDecisionAtin interfaceFrameInstance- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
setFrameSent
public void setFrameSent(boolean sent) Information provided by the PKI file:
\brief Sets the frame as sent or unsent. \param sent, true for sent, false for unsent.- Specified by:
setFrameSentin interfaceFrameInstance- Parameters:
sent- Takes in a parameter of sent
-
isFrameSent
public boolean isFrameSent()Information provided by the PKI file:
\brief Returns true if the the frame is sent, otherwise false. \return bool, true if the the frame is sent, otherwise false.- Specified by:
isFrameSentin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
setFrameBuffered
public void setFrameBuffered(boolean buffered) Information provided by the PKI file:
\brief Sets the frame as buffered or unbuffered. \param buffered, true for buffered, false for unbuffered.- Specified by:
setFrameBufferedin interfaceFrameInstance- Parameters:
buffered- Takes in a parameter of buffered
-
isFrameBuffered
public boolean isFrameBuffered()Information provided by the PKI file:
\brief Returns true if the the frame is buffered, otherwise false. \return bool, true if the the frame is buffered, otherwise false.- Specified by:
isFrameBufferedin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
setFrameDropped
public void setFrameDropped(boolean dropped) Information provided by the PKI file:
\brief Sets the frame as dropped or not dropped. \param dropped, true for dropped, false for not dropped.- Specified by:
setFrameDroppedin interfaceFrameInstance- Parameters:
dropped- Takes in a parameter of dropped
-
isFrameDropped
public boolean isFrameDropped()Information provided by the PKI file:
\brief Returns true if the the frame is dropped, otherwise false. \return bool, true if the the frame is dropped, otherwise false.- Specified by:
isFrameDroppedin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
setFrameNotForwarded
public void setFrameNotForwarded(boolean notForwarded) Information provided by the PKI file:
\brief Sets the frame as not forwarded or forwarded. \param notForwarded, true for not forwarded, false for forwarded.- Specified by:
setFrameNotForwardedin interfaceFrameInstance- Parameters:
notForwarded- Takes in a parameter of notForwarded
-
isFrameNotForwarded
public boolean isFrameNotForwarded()Information provided by the PKI file:
\brief Returns true if the the frame is not forwarded, otherwise false. \return bool, true if the the frame is not forwarded, otherwise false.- Specified by:
isFrameNotForwardedin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
setFrameAccepted
public void setFrameAccepted(boolean accepted) Information provided by the PKI file:
\brief Sets the frame as accepted or not accepted. \param accepted, true for accepted, false for not accepted.- Specified by:
setFrameAcceptedin interfaceFrameInstance- Parameters:
accepted- Takes in a parameter of accepted
-
isFrameAccepted
public boolean isFrameAccepted()Information provided by the PKI file:
\brief Returns true if the the frame is accepted, otherwise false. \return bool, true if the the frame is accepted, otherwise false.- Specified by:
isFrameAcceptedin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
setFrameUnexpected
public void setFrameUnexpected(boolean unexpected) Information provided by the PKI file:
\brief Sets the frame as unexpected or expected. \param unexpected, true for unexpected, false for expected.- Specified by:
setFrameUnexpectedin interfaceFrameInstance- Parameters:
unexpected- Takes in a parameter of unexpected
-
isFrameUnexpected
public boolean isFrameUnexpected()Information provided by the PKI file:
\brief Returns true if the the frame is unexpected, otherwise false. \return bool, true if the the frame is unexpected, otherwise false.- Specified by:
isFrameUnexpectedin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
isFrameCollidedOnLink
public boolean isFrameCollidedOnLink()Information provided by the PKI file:
\brief Returns true if the frame collided on the link, otherwise false. \return bool, true if the frame collided on the link, otherwise false.- Specified by:
isFrameCollidedOnLinkin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
isFrameCollidedAtDevice
public boolean isFrameCollidedAtDevice()Information provided by the PKI file:
\brief Returns true if the frame collided at the device, otherwise false. \return bool, true if the frame collided at the device, otherwise false.- Specified by:
isFrameCollidedAtDevicein interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
isFrameOnTransit
public boolean isFrameOnTransit()Information provided by the PKI file:
\brief Returns true if the frame is in transit, otherwise false. \return bool, true if the frame is in transit, otherwise false.- Specified by:
isFrameOnTransitin interfaceFrameInstance- Returns:
- boolean Returns a boolean
-
getQosStampColorCode
public int getQosStampColorCode()Information provided by the PKI file:
\brief Returns the QoS stamp color code. \return int, the QoS stamp color code.- Specified by:
getQosStampColorCodein interfaceFrameInstance- Returns:
- int Returns a int
-
getInQosStampColorCode
public int getInQosStampColorCode()Information provided by the PKI file:
\brief Returns the inbound QoS stamp color code. \return int, the inbound QoS stamp color code.- Specified by:
getInQosStampColorCodein interfaceFrameInstance- Returns:
- int Returns a int
-
getOutQosStampColorCode
public int getOutQosStampColorCode()Information provided by the PKI file:
\brief Returns the outbound QoS stamp color code. \return int, the outbound QoS stamp color code.- Specified by:
getOutQosStampColorCodein interfaceFrameInstance- Returns:
- int Returns a int
-
getTransitTime
public int getTransitTime()Information provided by the PKI file:
\brief Returns the transit time. \return int, the transit time.- Specified by:
getTransitTimein interfaceFrameInstance- Returns:
- int Returns a int
-
getPercentageSent
public int getPercentageSent()Information provided by the PKI file:
\brief Returns the percentage of the frame that was sent. \return int, the percentage of the frame that was sent.- Specified by:
getPercentageSentin interfaceFrameInstance- Returns:
- int Returns a int
-
getStartSimTime
public long getStartSimTime()Information provided by the PKI file:
\brief Returns the simulation start time. \return int, the simulation start time.- Specified by:
getStartSimTimein interfaceFrameInstance- Returns:
- long Returns a long
-
getTrafficSource
Information provided by the PKI file:
\brief Returns the traffic source. \return UserTraffic, the soure UserTraffic object.- Specified by:
getTrafficSourcein interfaceFrameInstance- Returns:
- UserTraffic Returns a UserTraffic
-
getTime
public int getTime()Information provided by the PKI file:
\brief Returns time of the frame instance. \return int, time of the frame instance.- Specified by:
getTimein interfaceFrameInstance- Returns:
- int Returns a int
-